docs(readme): update README with new deployment steps and reorganize contribution guide by akaBoyLovesToCode · Pull Request #25 · embyplus/embyBot

akaBoyLovesToCode · 2025-02-15T15:41:14Z

This PR includes one documentation-related change:

Update README Content:

Updated the README with new deployment steps, replacing pip with uv commands (uv sync and uv run) for environment setup and bot execution.
Enhanced the overall layout and formatting of the README for improved clarity.
Added an English version of the README to broaden accessibility.
Moved the contribution guide to a separate CONTRIBUTING.md file for better organization.
Integrated various badges (e.g., license, Python version, code quality, and Ruff) to provide quick access to project metrics.

These updates aim to streamline the deployment process and improve the documentation structure, making it more user-friendly and maintainable.

好的，这是将 pull request 总结翻译成中文的结果：

Sourcery 提供的总结

更新文档以反映使用 uv 的新部署流程，并改进整体结构和清晰度。创建一个专门的 CONTRIBUTING.md 文件，并添加 README 的英文版本。

部署：

更新部署说明以使用 uv；将 pip 替换为 uv sync 和 uv run 命令

文档：

创建一个新的 CONTRIBUTING.md 文件，其中包含贡献指南
添加 README 的英文版本
通过将贡献指南移动到单独的文件来重新组织 README
使用新的部署步骤更新 README
将各种徽章添加到 README，包括许可证、Python 版本、代码质量和 Ruff
改进 README 的整体布局和格式

Original summary in English

Summary by Sourcery

Update the documentation to reflect the new deployment process using uv and improve the overall structure and clarity. Create a dedicated CONTRIBUTING.md file and add an English version of the README.

Deployment:

Update deployment instructions to use uv; replace pip with uv sync and uv run commands

Documentation:

Create a new CONTRIBUTING.md file with contribution guidelines
Add an English version of the README
Reorganize the README by moving the contribution guide to a separate file
Update the README with new deployment steps
Add various badges to the README, including license, Python version, code quality, and Ruff
Improve the overall layout and formatting of the README

…ibution guide - Replaced `pip` with `uv` for deployment and added `uv sync` and `uv run` commands for environment setup and bot execution - Enhanced README layout with improved clarity and formatting - Added English version of the README - Moved the contribution guide to `CONTRIBUTING.md` for better organization - Added badges for various services such as license, Python version, code quality, and ruff

sourcery-ai · 2025-02-15T15:41:23Z

## Sourcery 审查者指南

此 PR 使用 `uv` 更新了 README 中的新部署步骤，增强了布局和格式，添加了英文版本，将贡献指南移至单独的文件，并集成了各种项目指标的徽章。通过用 `uv` 命令替换 `pip`，部署过程得到了简化。贡献指南被移动到 `CONTRIBUTING.md`，以改进文档结构。

#### 部署流程图

```mermaid
flowchart TD
    A[克隆仓库] --> B{配置 .env 文件}
    B --> C[uv sync]
    C --> D[uv run app.py]
    D --> E(机器人正在运行)

文件级别变更

变更	详情	文件
使用 `uv` 而不是 `pip` 更新了 README 中的新部署步骤。	将 `pip sync` 替换为 `uv sync`。将 `pip run` 替换为 `uv run`。	`README.md`
增强了 README 的布局和格式，以提高清晰度，并添加了英文版本。	改进了 README 的整体布局。增强了格式，以提高可读性。添加了 README 的英文版本。	`README.md`
将贡献指南移动到单独的 `CONTRIBUTING.md` 文件。	创建了一个新的 `CONTRIBUTING.md` 文件。从 `README.md` 文件中删除了贡献指南。	`CONTRIBUTING.md` `README.md`
集成了各种徽章，以提供对项目指标的快速访问。	添加了许可证徽章。添加了 Python 版本徽章。添加了代码质量徽章。添加了 Ruff 徽章。	`README.md`

提示和命令

与 Sourcery 互动

触发新的审查： 在 pull request 上评论 @sourcery-ai review。
继续讨论： 直接回复 Sourcery 的审查评论。
从审查评论生成 GitHub issue： 通过回复审查评论，要求 Sourcery 从审查评论创建一个 issue。您也可以回复审查评论并使用 @sourcery-ai issue 从中创建一个 issue。
生成 pull request 标题： 在 pull request 标题中的任何位置写入 @sourcery-ai，以随时生成标题。您也可以在 pull request 上评论 @sourcery-ai title，以随时（重新）生成标题。
生成 pull request 摘要： 在 pull request 正文中的任何位置写入 @sourcery-ai summary，以随时在您想要的位置生成 PR 摘要。您也可以在 pull request 上评论 @sourcery-ai summary，以随时（重新）生成摘要。
生成审查者指南： 在 pull request 上评论 @sourcery-ai guide，以随时（重新）生成审查者指南。
解决所有 Sourcery 评论： 在 pull request 上评论 @sourcery-ai resolve，以解决所有 Sourcery 评论。如果您已经解决了所有评论并且不想再看到它们，这将非常有用。
驳回所有 Sourcery 审查： 在 pull request 上评论 @sourcery-ai dismiss，以驳回所有现有的 Sourcery 审查。如果您想从新的审查开始，这将特别有用 - 不要忘记评论 @sourcery-ai review 以触发新的审查！
为 issue 生成行动计划： 在 issue 上评论 @sourcery-ai plan，以生成行动计划。

自定义您的体验

访问您的仪表板以：

启用或禁用审查功能，例如 Sourcery 生成的 pull request 摘要、审查者指南等。
更改审查语言。
添加、删除或编辑自定义审查说明。
调整其他审查设置。

获取帮助

联系我们的支持团队提出问题或反馈。
访问我们的文档获取详细指南和信息。
通过在 X/Twitter, LinkedIn 或 GitHub 上关注我们，与 Sourcery 团队保持联系。

```

Original review guide in English

Reviewer's Guide by Sourcery

This PR updates the README with new deployment steps using uv, enhances the layout and formatting, adds an English version, moves the contribution guide to a separate file, and integrates various badges for project metrics. The deployment process is streamlined by replacing pip with uv commands. The contribution guide is moved to CONTRIBUTING.md to improve the documentation structure.

Flow Diagram for Deployment Process

flowchart TD
    A[Clone Repository] --> B{Configure .env File}
    B --> C[uv sync]
    C --> D[uv run app.py]
    D --> E(Bot is Running)

File-Level Changes

Change	Details	Files
Updated the README with new deployment steps using `uv` instead of `pip`.	Replaced `pip sync` with `uv sync`. Replaced `pip run` with `uv run`.	`README.md`
Enhanced the README's layout and formatting for improved clarity and added an English version.	Improved the overall layout of the README. Enhanced the formatting for better readability. Added an English version of the README.	`README.md`
Moved the contribution guide to a separate `CONTRIBUTING.md` file.	Created a new `CONTRIBUTING.md` file. Removed the contribution guide from the `README.md` file.	`CONTRIBUTING.md` `README.md`
Integrated various badges to provide quick access to project metrics.	Added license badge. Added Python version badge. Added code quality badge. Added Ruff badge.	`README.md`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

嘿 @Qubbby - 我已经查看了你的更改 - 这里有一些反馈：

总体评论：

考虑在 README 中添加目录，以便更轻松地导航。
README 徽章看起来很棒，但考虑添加替代文字以提高可访问性。

以下是我在审查期间查看的内容

🟡 一般问题：发现 1 个问题
🟢 安全性：一切看起来都很好
🟢 测试：一切看起来都很好
🟢 复杂性：一切看起来都很好
🟢 文档：一切看起来都很好

Sourcery 对开源是免费的 - 如果你喜欢我们的评论，请考虑分享它们 ✨

_{请帮助我更有用！请点击每个评论上的 👍 或 👎，我将使用反馈来改进你的评论。}

Original comment in English

Hey @Qubbby - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider adding a table of contents to the README for easier navigation.
The README badges look great, but consider adding alt text to improve accessibility.

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

sourcery-ai · 2025-02-15T15:42:16Z

README.md

+<img src="https://img.shields.io/badge/code%20style-PEP%208-000000.svg?logo=python&logoColor=blue" alt="PEP 8">
+</a>
+<br />
+<a bref="https://github.com/astral-sh/ruff">


issue (typo): 错别字："bref" 应该为 "href"。

Suggested change

<a bref="https://github.com/astral-sh/ruff">

<a href="https://github.com/astral-sh/ruff">

Original comment in English

issue (typo): Typo: "bref" should be "href".

Suggested change

<a bref="https://github.com/astral-sh/ruff">

<a href="https://github.com/astral-sh/ruff">

- Changed `<a bref="https://github.com/astral-sh/ruff">` to `<a href="https://github.com/astral-sh/ruff">` - Fixed incorrect attribute name to ensure proper link rendering

akaBoyLovesToCode · 2025-02-15T15:52:37Z

@sourcery-ai review
I have solved the issue:
issue (typo): 错别字："bref" 应该为 "href"。

akaBoyLovesToCode added 2 commits February 15, 2025 23:26

chore(docs): remove readme.md to rename with uppercase filename

1a02624

sourcery-ai bot reviewed Feb 15, 2025

View reviewed changes

fix(readme): correct typo in Ruff badge link attribute

c989f57

- Changed `<a bref="https://github.com/astral-sh/ruff">` to `<a href="https://github.com/astral-sh/ruff">` - Fixed incorrect attribute name to ensure proper link rendering

akaBoyLovesToCode changed the title ~~docs(README): update README with new deployment steps and reorganize contribution guide~~ docs(readme): update README with new deployment steps and reorganize contribution guide Feb 16, 2025

akaBoyLovesToCode closed this by deleting the head repository Mar 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(readme): update README with new deployment steps and reorganize contribution guide#25

docs(readme): update README with new deployment steps and reorganize contribution guide#25
akaBoyLovesToCode wants to merge 3 commits intoembyplus:mainfrom
akaBoyLovesToCode:readme

akaBoyLovesToCode commented Feb 15, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Feb 15, 2025 •

edited

Loading

与 Sourcery 互动

自定义您的体验

获取帮助

Reviewer's Guide by Sourcery

Flow Diagram for Deployment Process

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

sourcery-ai bot Feb 15, 2025

Uh oh!

akaBoyLovesToCode commented Feb 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	<a bref="https://github.com/astral-sh/ruff">
	<a href="https://github.com/astral-sh/ruff">

Conversation

akaBoyLovesToCode commented Feb 15, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Sourcery 提供的总结

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

文件级别变更

与 Sourcery 互动

自定义您的体验

获取帮助

Reviewer's Guide by Sourcery

Flow Diagram for Deployment Process

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Feb 15, 2025

Choose a reason for hiding this comment

Uh oh!

akaBoyLovesToCode commented Feb 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

akaBoyLovesToCode commented Feb 15, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 15, 2025 •

edited

Loading